package gui;
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All  Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * -Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 * 
 * -Redistribution in binary form must reproduct the above copyright
 *  notice, this list of conditions and the following disclaimer in
 *  the documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
 * ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN AND ITS LICENSORS SHALL NOT
 * BE LIABLE FOR ANY DAMAGES OR LIABILITIES SUFFERED BY LICENSEE AS A RESULT
 * OF OR RELATING TO USE, MODIFICATION OR DISTRIBUTION OF THE SOFTWARE OR ITS
 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
 * REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
 * INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY
 * OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN
 * IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that Software is not designed, licensed or intended for
 * use in the design, construction, operation or maintenance of any nuclear
 * facility.
 */

/*
 * @(#)JavaFileFilter.java	1.14 03/01/23
 */


import javax.swing.filechooser.FileFilter;
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;

/**
 * A convenience implementation of FileFilter that filters out
 * all files except for those type extensions that it knows about.
 * <p/>
 * Extensions are of the type ".foo", which is typically found on
 * Windows and Unix boxes, but not on Macinthosh. Case is ignored.
 * <p/>
 * Example - create a new filter that filerts out all files
 * but gif and jpg image files:
 * <p/>
 * JFileChooser chooser = new JFileChooser();
 * JavaFileFilter filter = new JavaFileFilter(
 * new String{"gif", "jpg"}, "JPEG & GIF Images")
 * chooser.addChoosableFileFilter(filter);
 * chooser.showOpenDialog(this);
 *
 * @author Jeff Dinkins
 * @version 1.14 01/23/03
 */
public class JavaFileFilter extends FileFilter {

    private HashMap<String, JavaFileFilter> filters;
    private String description;
    private boolean useExtensionsInDescription = true;

    /**
     * Creates a file filter. If no filters are added, then all
     * files are accepted.
     *
     * @see #addExtension
     */
    public JavaFileFilter() {
        filters = new HashMap<String, JavaFileFilter>();
    }

    /**
     * Creates a file filter that accepts files with the given extension.
     * Example: new JavaFileFilter("jpg");
     *
     * @param extension i.e., "jpg"
     * @see #addExtension
     */
    public JavaFileFilter(String extension) {
        this(extension, null);
    }

    /**
     * Creates a file filter that accepts the given file type.
     * Example: new JavaFileFilter("jpg", "JPEG Image Images");
     * <p/>
     * Note that the "." before the extension is not needed. If
     * provided, it will be ignored.
     *
     * @param extension   "jpg"
     * @param description "Image files"
     * @see #addExtension
     */
    public JavaFileFilter(String extension, String description) {
        this();
        if (extension != null) addExtension(extension);
        if (description != null) setDescription(description);
    }

// --Commented out by Inspection START (4/30/07 5:21 PM):
//    /**
//     * Creates a file filter from the given string array.
//     * Example: new JavaFileFilter(String {"gif", "jpg"});
//     * <p/>
//     * Note that the "." before the extension is not needed adn
//     * will be ignored.
//     *
//     * @param filters list of filters
//     * @see #addExtension
//     */
//    public JavaFileFilter(String[] filters) {
//        this(filters, null);
//    }
// --Commented out by Inspection STOP (4/30/07 5:21 PM)

    /**
     * Creates a file filter from the given string array and description.
     * Example: new JavaFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");
     * <p/>
     * Note that the "." before the extension is not needed and will be ignored.
     *
     * @param filters     list of filters
     * @param description i.e, "Gif and JPG Images"
     * @see #addExtension
     */
    public JavaFileFilter(String[] filters, String description) {
        this();
        for (String filter : filters) {
            // add filters one by one
            addExtension(filter);
        }
        if (description != null) setDescription(description);
    }

    /**
     * Return true if this file should be shown in the directory pane,
     * false if it shouldn't.
     * <p/>
     * Files that begin with "." are ignored.
     *
     * @see #getExtension
     * @see #accept
     */
    public boolean accept(File f) {
        if (f != null) {
            if (f.isDirectory()) {
                return true;
            }
            String extension = getExtension(f);
            if (extension != null && filters.get(getExtension(f)) != null) {
                return true;
            }
        }
        return false;
    }

    /**
     * @param f file
     * @return the extension portion of the file's name .
     * @see #getExtension
     * @see FileFilter#accept
     */
    public String getExtension(File f) {
        if (f != null) {
            String filename = f.getName();
            int i = filename.lastIndexOf('.');
            if (i > 0 && i < filename.length() - 1) {
                return filename.substring(i + 1).toLowerCase();
            }
        }
        return null;
    }

    /**
     * Adds a filetype "dot" extension to filter against.
     * <p/>
     * For example: the following code will create a filter that filters
     * out all files except those that end in ".jpg" and ".tif":
     * <p/>
     * JavaFileFilter filter = new JavaFileFilter();
     * filter.addExtension("jpg");
     * filter.addExtension("tif");
     * <p/>
     * Note that the "." before the extension is not needed and will be ignored.
     *
     * @param extension additional extension
     */
    public void addExtension(String extension) {
        if (filters == null) {
            filters = new HashMap<String, JavaFileFilter>(5);
        }
        filters.put(extension.toLowerCase(), this);
    }


    /**
     * Returns the human readable description of this filter. For
     * example: "JPEG and GIF Image Files (*.jpg, *.gif)"
     *
     * @see #setDescription
     * @see #isExtensionListInDescription
     * @see #getDescription
     */
    public String getDescription() {
        String fullDescription;
        if (description == null || isExtensionListInDescription()) {
            fullDescription = description == null ? "(" : description + " (";
            // build the description from the extension list
            Iterator<String> extensions = filters.keySet().iterator();
            if (extensions != null) {
                fullDescription += "." + extensions.next();
                while (extensions.hasNext()) {
                    fullDescription += ", ." + extensions.next();
                }
            }
            fullDescription += ")";
        } else {
            fullDescription = description;
        }
        return fullDescription;
    }

    /**
     * Sets the human readable description of this filter. For
     * example: filter.setDescription("Gif and JPG Images");
     *
     * @param description i.e, "Gif and JPG Images"
     * @see #setDescription
     * @see #setExtensionListInDescription
     * @see #isExtensionListInDescription
     */
    public void setDescription(String description) {
        this.description = description;
    }

// --Commented out by Inspection START (4/30/07 5:21 PM):
//    /**
//     * Determines whether the extension list (.jpg, .gif, etc) should
//     * show up in the human readable description.
//     * <p/>
//     * Only relevent if a description was provided in the constructor
//     * or using setDescription();
//     *
//     * @param b true to turn on description
//     * @see #getDescription
//     * @see #setDescription
//     * @see #isExtensionListInDescription
//     */
//    public void setExtensionListInDescription(boolean b) {
//        useExtensionsInDescription = b;
//    }
// --Commented out by Inspection STOP (4/30/07 5:21 PM)

    /**
     * Only relevent if a description was provided in the constructor
     * or using setDescription();
     *
     * @return whether the extension list (.jpg, .gif, etc) should
     *         show up in the human readable description.
     * @see #getDescription
     * @see #setDescription
     */
    public boolean isExtensionListInDescription() {
        return useExtensionsInDescription;
    }
}
